home *** CD-ROM | disk | FTP | other *** search
/ Amiga Collections: Bavarian / Bavarian #158 (19xx)(APS Electronic).zip / Bavarian #158 (19xx)(APS Electronic).adf / play.doc < prev    next >
Text File  |  1988-08-07  |  9KB  |  224 lines
  1. PLAY Documentation
  2. ==================
  3.  
  4. Sonix Score Player 1.0 - December 1, 1987
  5. (C) Copyright 1987 Mark Riley,
  6. All Rights Reserved.
  7.  
  8. Some Information About PLAY
  9. ===========================
  10.  
  11. PLAY is that program you've been patiently waiting for that'll let you
  12. listen to Sonix tunes without Sonix itself.  Not only can you play scores,
  13. but you can also create PLAY scripts that play multiple scores, one right
  14. after the next.  This allows for continuous music which is desirable for
  15. slide shows and the like.  This is possible since PLAY can start a score
  16. playing, while preloading the next score.  In addition, PLAY may be used
  17. from either the Workbench or the CLI.
  18.  
  19. This program is ShareWare; it isn't free.  If you like PLAY and want to
  20. continue to use it, please send $10 to the address below.  This will make
  21. you a legal user of PLAY.
  22.  
  23.   Mark Riley - Play
  24.   P.O. Box 234
  25.   Simi Valley, CA 93062
  26.  
  27.  
  28. Important Note
  29. ==============
  30.  
  31. You (as an individual) may freely redistribute PLAY in its original unaltered
  32. (and PAKed) state provided that you do not charge money for the program.
  33. PLAY is intended for private use only.  It is copyrighted software.  It may
  34. not be used (in full or in part) for commercial applications, nor may it be
  35. used for demonstration purposes associated with commercial applications.
  36. If it is your desire to do so, I may be reached at the above address or at
  37. (805) 583-8173 to discuss licensing arrangements for including PLAY or its
  38. object code routines into your application.
  39.  
  40.  
  41. What You've Got Here
  42. ====================
  43.  
  44. Play           The Sonix score player itself
  45. Play.doc       The file you are now reading
  46. Play.info      An icon for the score player
  47. Score.info     A generic score icon
  48. Script.info    A generic script file icon
  49. Scores.info    A generic scores drawer icon
  50.  
  51.  
  52. Playing Scores from the Workbench
  53. =================================
  54.  
  55. Before you can use PLAY from the Workbench, there's a little setting up
  56. to do.  First off, PLAY and it's ".info" file should be copied to the root
  57. directory of the disk that contains your Sonix scores.  Secondly, if your
  58. scores are located in a directory other than the root, you need to copy
  59. the "Scores.info" drawer icon into the score directory's parent directory.
  60. If your score directory is named "My Tunes" then the drawer icon should
  61. be named "My Tunes.info".  Thirdly, you need to make copies of the
  62. "Score.info" icon file for each score and place them in the same directory
  63. as that score.  These icons must have the same name as the score file with
  64. ".info" appended at the end.  If a score is named "Jingle Bells.smus" then
  65. the corresponding icon should be named "Jingle Bells.smus.info".  If the
  66. instruments for a particular score are in a different directory, then you
  67. must specify where they are in the icon file.  To do this, select the icon
  68. for the score, then select the Info item in the Workbench menu.  In the
  69. Tool Types box type the pathname of the instrument directory after the
  70. "I=" and Save the info file.  Relative pathnames such as "I=/Instruments"
  71. are ok here.
  72.  
  73. Now, just double click on a score icon and it should load and play.  You
  74. may also use extended selection to play multiple scores in the order they
  75. were selected.  If PLAY encounters a problem and can't load the score it
  76. will "beep" the display and try to load the next score (if any.)  If you
  77. wish to stop playing a score, double click on the PLAY icon.  Also, if
  78. you try to play a score while another is playing, the new score will
  79. override the previous one.
  80.  
  81.  
  82. Playing Scores from the CLI
  83. ===========================
  84.  
  85. Usage: PLAY [*] [I=instrdir] score[.SMUS]
  86.  
  87. If you plan on using PLAY from the CLI then copy "Play" to your commands
  88. "c:" directory.  Just specify the pathname for the instruments directory
  89. and the pathname for the score, and PLAY will load and play that score.
  90. You don't need to type the ".smus" part of the score name as PLAY will
  91. do that for you if necessary.  Use quotes if a pathname has spaces in it.
  92. If you want PLAY to run asynchronously, add the asterisk as the first
  93. parameter.  This works better than "run" because it allows you to perform
  94. an "endcli" properly.  This is useful for playing songs from a startup
  95. sequence.  To stop a score while playing, just issue a Ctrl-C to abort
  96. (if PLAY is running asynchronously then use "play *" or start another score
  97. playing to abort the original score.)
  98.  
  99. Example:
  100.  
  101. 1> dir
  102.      Scores (dir)
  103.      Instruments (dir)
  104. 1> dir scores
  105.   Jingle Bells.smus           Cameo.smus
  106.   YTV.smus
  107. 1> play i=instruments "scores/jingle bells"
  108. 1> cd scores
  109. 1> play i=/instruments ytv cameo.smus
  110. 1> cd /instruments
  111. 1> play * /scores/cameo
  112. 1> 
  113.  
  114.  
  115. Creating & Using PLAY Scripts
  116. =============================
  117.  
  118. PLAY scripts basicly allow you to sequence through many songs back-to-back.
  119. This feature is especially useful for slide shows or demonstrations that
  120. require backround music.  You might even want to setup a sequence of songs
  121. you want your Amiga to play in the backround while you are busy with other
  122. tasks.  One important feature of PLAY scripts is that they enable you
  123. to play one score while loading the next.  This way you get continuous
  124. music since no time is spent loading a score between songs.
  125.  
  126. To create a PLAY script, you need a text editor of some type.  PLAY scripts
  127. consist of a series of options seperated by spaces, commas, or carriage
  128. returns.  Most options consist of a letter, an equals sign "=", and an
  129. argument.  If an argument (such as a pathname) has spaces in it then
  130. enclose that argument in quotes.  When you save your PLAY script, you might
  131. want to use the extension ".play" so that you can distinguish PLAY scripts
  132. from other types of files.  PLAY script options are discussed in the next
  133. section.
  134.  
  135. You may start a PLAY script from either the Workbench or the CLI.  You must
  136. put a copy of the "Script.info" icon file in the same directory with your
  137. PLAY script (appropriately renamed.)  Just double-click on the icon to
  138. start your script playing.  To invoke a PLAY script from the CLI you
  139. use the following:
  140.  
  141. Usage: PLAY [*] P=script
  142.  
  143. In addition to aborting a PLAY script with a Ctrl-C, you may stop the
  144. current song and skip to the next with a Ctrl-E.  When invoked from
  145. a CLI, PLAY can report any errors it encounters within a script file.
  146.  
  147. Example:
  148.  
  149. 1> dir
  150.      Scores (dir)
  151.      Instruments (dir)
  152.   Demo.play
  153. 1> dir scores
  154.   Cool.smus                   Cameo.smus
  155.   Rollover.smus               YTV.smus
  156. 1> type demo.play
  157. ;This is a demo PLAY script:
  158.  
  159. d=scores        ;Set current directory
  160. i=/instruments  ;Specify instruments directory
  161.  
  162. r=2                 ;Repeat the following twice
  163.   v=128 c=3 a=cool  ;1/2 volume & repeated 3 times
  164.   v=-1 a=cameo      ;Use score's original volume
  165. .                   ;End of repeat loop
  166.  
  167. r=0           ;Repeat the following forever
  168.   a=rollover  ;A bunch of asyncronous scores
  169.   a=ytv
  170.   c=2 a=cool  ;Repeated twice again
  171.   a=cameo
  172. .             ;End of repeat loop
  173. 1> play p=demo.play
  174. 1> 
  175.  
  176.  
  177. PLAY Script Options
  178. ===================
  179.  
  180. These options may be used in either a PLAY script or in the command line
  181. itself.  For simplicity's sake, the usage desciptors do not indicate all
  182. of these options.
  183.  
  184. score       A filename by itself indicates a score to be loaded and played.
  185.             PLAY will append ".smus" to the filename as necessary.
  186.  
  187. A=score     This option tells PLAY to play the specified score and proceed
  188.             immediately with loading the next score.  This allows for
  189.             continuously playing music.  One drawback is that you need
  190.             enough memory to hold two scores and their instruments into
  191.             memory at one time.
  192.  
  193. I=instrdir  This specifies to PLAY where to look for a score's instruments.
  194.             This applies to all subsequent scores until it is changed again
  195.             with another "I=".  Relative pathnames are ok here.
  196.  
  197. D=newdir    PLAY scripts inherit their current directory from the Workbench
  198.             or CLI.  You can specify a new current directory with this
  199.             option.  Relative pathnames are also legal here.
  200.  
  201. C=count     Specifies how many times to repeat a score.  A value of zero
  202.             indicates that this score is to be repeated forever (or until
  203.             aborted...)  The count value applies only to the next score to
  204.             be played.
  205.  
  206. V=volume    Specifies the volume at which the following scores will be
  207.             played.  The valid range is from 0 to 255.  A value of -1
  208.             uses the score's default volume.
  209.  
  210. R=repeat    This option allows you to repeat a block of options (and
  211. .           scores) a number of times.  The repeat block is bounded by
  212.             the repeat option and a period "." (or another repeat option.)
  213.             A value of zero indicates that the block is to be repeated
  214.             forever.  Repeat blocks only work from within PLAY scripts.
  215.  
  216. ;comment    A semi-colon ";" indicates that the rest of a line is a
  217.             comment.
  218.  
  219. P=script    You may link to another PLAY script from within a PLAY script.
  220.  
  221.  
  222.  
  223.  
  224.